getSongHistory

Returns a list of airplay histories for one or more specified songs.

Sample Request

<mmRequest command="getSongHistory" station="ID" [version="1"] [client=""] [userData=""]>
	<contents>
		[<maxHistories>10</maxHistories>]
		[<archiveHistory>1</archiveHistory>]
		<songList>
			<song [songId="1"] [cutId="x"] />
		</songList>
	</contents>
</mmRequest>

Request Notes

maxHistories – the maximum number of histories that will be returned. By default, all available active histories will be returned. These always begin with the newest history and work backward in time.

 

archiveHistory - allows this command to include archived history. When set to "1", this allows the inclusion of archived history.

 

The song tags define the songs that you wish to retrieve histories for. You can look up songs by their MusicMaster Song ID or their element ID from a third party system.

• songId – the MusicMaster Song ID of the element, if known.
• cutId – the element ID from the third party system.

 

Note that while songId and cutId are both listed as optional, one or the other must be included. Performance can be improved by using the MusicMaster songId for this function.

Sample Reply

<mmReply command="getSongHistory" station="ID" version="1" [userData=""] status="???????">
	<contents>
		<songList>
			<song songId="1">
				<historyList>
					<history historyId="1" airDate="yyyy-mm-dd" airTime="hh:mm:ss" runTime="mm:ss" />
				</historyList>
			</song>
		</songList>
	</contents>
</mmReply>

Compatibility and Version Info

Available with MusicMaster PRO 5.0sr14 and later